/* Copyright (c) 2012 swing-on-fire Team
 * 
 * This file is part of Swing-On-Fire (http://code.google.com/p/swing-on-fire), licensed under the terms of the MIT
 * License (MIT).
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
package com.google.code.swingonfire.animation;

/**
 * Abstract base class for an animation. Contains a fixed duration.
 * 
 * @author Manfred HANTSCHEL
 */
public abstract class AbstractAnimation implements DurableAnimation
{

    private final double duration;

    /**
     * Creates the animation with an infinite duration.
     */
    public AbstractAnimation()
    {
        this(Double.NaN);
    }

    /**
     * Creates the animation with the specified duration. A duration of 0 indicates that the animation should only run
     * once. Double.NaN, Double.*INFINITE or less than 0 to indicates that the animation has no predefined duration.
     * 
     * @param duration the duration
     */
    public AbstractAnimation(double duration)
    {
        super();

        this.duration = duration;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public double getDuration()
    {
        return duration;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void animationReset()
    {
        // intentionally left blank
    }

}
